home *** CD-ROM | disk | FTP | other *** search
/ System Booster / System Booster.iso / Archives / ARexxTools / ARexxGuide2_0A.readme < prev    next >
Encoding:
Text File  |  1996-09-27  |  11.0 KB  |  243 lines
  1. Short: Complete ARexx reference. AmigaGuide.
  2. Type: util/rexx
  3. Uploader: robin@halcyon.com
  4. Author: Robin Evans
  5.  
  6. Keywords: ARexx,manual,reference,tutorial,AmigaGuide,script,TurboText,Edge,Ed
  7.  
  8.  DESCRIPTION
  9.  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  10. ARexxGuide is a complete ARexx reference with tutorials and dozens
  11. of ready-to-use examples. Done in AmigaGuide format, it includes
  12. argument templates and descriptions of all instruction keywords, of
  13. built-in functions, and of the functions in rexxsupport.library.
  14. The basic elements of the language are fully explained. Example
  15. programs -- some of them interactive -- answer frequently-asked
  16. questions about the language. Sample clauses are included with each
  17. function and instruction explanation. Error codes and possible
  18. solutions are explained.
  19.  
  20. A help-system that will turn nearly any text editor into an online
  21. reference to ARexx is included. Working macros for three editors
  22. are provided as examples. A step-by-step tutorial explains the
  23. simple steps for making a new macro for a different editor.
  24.  
  25. ARexxGuide is a shareware offering. The suggested fee is $15.
  26.  
  27.  VERSION
  28.  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  29. 2.0a: Some embarrasing problems in the included scripts are fixed.
  30.       Those who previously downloaded the 2.0 version can get
  31.       copies of the fixed scripts in the archive ARexxG_20patch.lha.
  32.  
  33. The second edition includes extensive changes thoughout. Two new
  34. tutorials explain ARexx as a macro language. A new section on
  35. techniques answers frequently-asked questions about ARexx with
  36. example code that can often be plugged directly into a script. Each
  37. possible error code is explained.
  38.  
  39. Notes on compatability issues have been added throughout the guide.
  40. They show how ARexx differs from the standard definition of REXX
  41. and offer methods for handling the differences.
  42.  
  43. RQ version ======================
  44.  
  45. Two different versions of the second edition are distributed. Both
  46. include the same information, but present it in somewhat different
  47. ways. The RQ version uses requesters to show definitions and other
  48. information that is displayed in the standard version by moving to
  49. a new node. The RQ version uses `rexxreqtools.library' by Rafael
  50. D'Halleweyn. and `ReqTools' by Nico François to implement the
  51. requesters. Because the requesters must be able to communicate with
  52. AmigaGuide through ARexx, this version can be used only with
  53. pre-MultiView versions of AmigaGuide -- that is, with version 34 of
  54. the library.
  55.  
  56.  REQUIREMENTS
  57.  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  58. For the standard version: (ARexxGuide2_0A.lha)
  59.     Any AmigaGuide viewer.
  60.  
  61.     Multiview can be used with OS 3.x. Users of OS 1.3 or 2.x will
  62.     need the AmigaGuide utility and amigaguide.library which are
  63.     distributed by Commodore on most BBSes and networks that support
  64.     the Amiga.
  65.  
  66. For the RQ version: (ARexxGuide2_0rqA.lha)
  67.     AmigaGuide version 34 viewer and library.
  68.  
  69.     `reqtools.library' and `rexxreqtools.library'.
  70.  
  71.     These libraries are included in the distribution archives for
  72.     ReqTools by Nico François. Look for `ReqTools22a_User.lha' on
  73.     your favorite shareware source. A minimum version of 37.5 for
  74.     rexxreqtools.library is required.
  75.  
  76.  ARCHIVE CONTENTS
  77.  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  78. The ARexxGuide drawer of this archive contains 21 files that make
  79. up one AmigaGuide® application. The AmigaGuide files are:
  80.  
  81.   ArexxGuide.guide
  82.   ARx_Cmd.ag
  83.   ARx_Elements.ag
  84.   ARx_Elements2.ag
  85.   ARx_Elements3.ag
  86.   ARx_Func.ag
  87.   ARx_Func2.ag
  88.   ARx_Func3.ag
  89.   ARx_Func4.ag
  90.   ARx_Guide.xref
  91.   ARx_Index
  92.   ARx_Instr.ag
  93.   ARx_Instr2.ag
  94.   ARx_Instr3.ag
  95.   ARx_Intro.ag
  96.   ARx_Operator.ag
  97.   ARx_PrgUcr.ag
  98.   ARx_Tknq.ag
  99.   ARx_Tutor.ag
  100.   ARx_UcrTutor1.ag
  101.   ARx_UcrTutor2.ag
  102.  
  103. Only ARexxGuide.guide is intended as an AmigaGuide executable. The
  104. other files are called from within the main node of that guide.
  105.  
  106. The following ARexx script files, located in the same directory,
  107. are used to run interactive examples from ARexxGuide, or to provide
  108. utilities for the program:
  109.  
  110.   ARexxGuide.rexx
  111.   ARx_Cmpr.rexx
  112.   ARx_IactExamples.rexx
  113.   ARx_Reg.rexx
  114.   ARx_Setup.rexx
  115.   Arx_Trace.rexx
  116.  
  117. Two additional files are included with the RQ version of the guide.
  118.  
  119.   ARx_Glossary.rexx
  120.   ARx_GlossaryPort.rexx
  121.  
  122. The `Editors' drawer contains macros for the ARexxGuide help
  123. system. Example macros are included for Ed 2.0 (the editor that
  124. comes with the OS), TurboText, and Edge. A tutorial in ARexxGuide
  125. explains how to make a file for a different editor. Any editor that
  126. is capable of minimal communication with ARexx can be used.
  127.  
  128. The 'Extras' drawer contains some files that are not necessary, but
  129. may be helpful to some users. Read the opening comment for more
  130. information.
  131.  
  132. The file 'UnCrunch.rexx' is the the source document for the program
  133. included in the tutorial section.
  134.  
  135.  DISTRIBUTION
  136.  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  137. The files in this archive are copyright © 1993,1994 by Robin Evans
  138. and may be distributed only in the original form and only under the
  139. conditions outlined below.
  140.  
  141. Distribution of the material in this archive is prohibited if the
  142. contents of the original archive are altered in any way.
  143.  
  144. The archive may be distributed in its original form on local and
  145. national computer networks, on Aminet distribution channels
  146. (including the Walnut Creek CD-ROM), on Fish collections, or on
  147. disk collections distributed by non-profit entities. Distribution
  148. by other means (including distribution by profit-making entities
  149. other than those mentioned) is prohibited unless specific
  150. permission is granted.
  151.  
  152. Rights are reserved for other forms of distribution of this archive
  153. or of its contents individually, including but not limited to
  154. distribution of a printed version of any file contained in the
  155. archive, distribution with commercial products, or distribution on
  156. computer networks in hypertext form of any file in the archive.
  157. Contact the author for further information and permissions.
  158.  
  159.                Robin Evans                   10 Apr 1994
  160.  
  161.                   from Internet:
  162.                      robin@halcyon.com
  163.                      r.evans6@genie.geis.com
  164.  
  165.                   on GEnie:
  166.                      R.EVANS6
  167.  
  168.                   by phone:
  169.                      (206) 682-7077
  170.  
  171.  
  172. ============================= Archive contents =============================
  173.  
  174. Original  Packed Ratio    Date     Time    Name
  175. -------- ------- ----- --------- --------  -------------
  176.      948     338 64.3% 23-Mar-94 14:03:36  ARexxGuide.info
  177.    57862   13518 76.6% 05-Apr-94 11:23:48  ARexxGuide/ArexxGuide.guide
  178.      488     250 48.7% 23-Mar-94 14:03:36  ARexxGuide/ARexxGuide.guide.info
  179.     2368    1346 43.1% 23-Mar-94 14:03:36  ARexxGuide/ARexxGuide.info
  180.     7969    3230 59.4% 10-Apr-94 13:39:28  ARexxGuide/ARexxGuide.rexx
  181.     2075     715 65.5% 23-Mar-94 17:33:42  ARexxGuide/ARexxGuide.rexx.info
  182.    22718    8007 64.7% 05-Apr-94 11:21:44  ARexxGuide/ARx_Cmd.ag
  183.     3412    1501 56.0% 12-Mar-94 19:07:04  ARexxGuide/ARx_Cmpr.rexx
  184.     2075     719 65.3% 23-Mar-94 14:03:36  ARexxGuide/ARx_Cmpr.rexx.info
  185.    32198   11052 65.6% 05-Apr-94 11:24:10  ARexxGuide/ARx_Elements.ag
  186.    41151   13803 66.4% 06-Apr-94 16:40:30  ARexxGuide/ARx_Elements2.ag
  187.    46577   15913 65.8% 06-Apr-94 16:40:48  ARexxGuide/ARx_Elements3.ag
  188.    39913   11414 71.4% 05-Apr-94 11:27:44  ARexxGuide/ARx_Error.ag
  189.    42541   11138 73.8% 06-Apr-94 16:41:18  ARexxGuide/ARx_Func.ag
  190.    49733   13375 73.1% 06-Apr-94 16:41:44  ARexxGuide/ARx_Func2.ag
  191.    60813   17547 71.1% 06-Apr-94 16:42:06  ARexxGuide/ARx_Func3.ag
  192.    37979    9114 76.0% 06-Apr-94 16:42:22  ARexxGuide/ARx_Func4.ag
  193.    11907    1851 84.4% 21-Mar-94 15:30:54  ARexxGuide/ARx_Guide.xref
  194.    20460    7358 64.0% 02-Apr-94 14:51:34  ARexxGuide/ARx_IactExamples.rexx
  195.     2075     720 65.3% 23-Mar-94 14:03:36  ARexxGuide/ARx_IactExamples.rexx.info
  196.    63447   12373 80.4% 06-Apr-94 18:02:30  ARexxGuide/ARx_Index
  197.    45662   14430 68.3% 06-Apr-94 16:42:42  ARexxGuide/ARx_Instr.ag
  198.    47578   14475 69.5% 06-Apr-94 16:43:00  ARexxGuide/ARx_Instr2.ag
  199.    50991   16392 67.8% 06-Apr-94 16:44:10  ARexxGuide/ARx_Instr3.ag
  200.    32039   12530 60.8% 23-Mar-94 12:07:30  ARexxGuide/ARx_Intro.ag
  201.    18240    5736 68.5% 23-Mar-94 12:07:36  ARexxGuide/ARx_Operator.ag
  202.     7586    2411 68.2% 05-Apr-94 11:46:24  ARexxGuide/ARx_PrgUcr.ag
  203.    11078    3614 67.3% 02-Apr-94 14:49:44  ARexxGuide/ARx_RarpInfoWin.rexx
  204.     2075     716 65.4% 23-Mar-94 14:03:36  ARexxGuide/ARx_RarpInfoWin.rexx.info
  205.     8014    3323 58.5% 21-Mar-94 13:39:38  ARexxGuide/ARx_Reg.rexx
  206.     2075     721 65.2% 23-Mar-94 14:03:36  ARexxGuide/ARx_Reg.rexx.info
  207.    26036    8681 66.6% 06-Apr-94 16:27:16  ARexxGuide/ARx_Setup.rexx
  208.     2346    1328 43.3% 23-Mar-94 14:03:36  ARexxGuide/ARx_Setup.rexx.info
  209.    72795   24019 67.0% 06-Apr-94 16:33:14  ARexxGuide/ARx_Tknq.ag
  210.    10862    4180 61.5% 24-Mar-94 14:45:22  ARexxGuide/Arx_Trace.rexx
  211.     2075     721 65.2% 23-Mar-94 14:03:36  ARexxGuide/Arx_Trace.rexx.info
  212.    15752    5131 67.4% 06-Apr-94 16:45:12  ARexxGuide/ARx_UcrTutor1.ag
  213.    17773    5589 68.5% 06-Apr-94 16:45:24  ARexxGuide/ARx_UcrTutor2.ag
  214.     2827    1373 51.4% 05-Apr-94 09:49:08  ARexxGuide/ARxG_20patch.readme
  215.     2075     716 65.4% 05-Apr-94 09:51:48  ARexxGuide/ARxG_20patch.readme.info
  216.      948     342 63.9% 24-Mar-94 16:00:36  ARexxGuide/Editors.info
  217.    20519    6715 67.2% 30-Mar-94 11:23:30  ARexxGuide/Editors/ARx_Help.ed
  218.     2075     714 65.5% 23-Mar-94 13:45:40  ARexxGuide/Editors/ARx_Help.ed.info
  219.    17934    5979 66.6% 30-Mar-94 11:22:52  ARexxGuide/Editors/ARx_Help.edge
  220.     2749     950 65.4% 23-Mar-94 13:45:40  ARexxGuide/Editors/ARx_Help.edge.info
  221.    19155    6221 67.5% 30-Mar-94 11:24:10  ARexxGuide/Editors/ARx_Help.ttx
  222.      778     366 52.9% 23-Mar-94 13:45:42  ARexxGuide/Editors/ARx_Help.ttx.info
  223.     4368    1661 61.9% 23-Mar-94 13:44:04  ARexxGuide/Editors/ARx_HelpSystem.README
  224.     2075     715 65.5% 23-Mar-94 13:45:42  ARexxGuide/Editors/ARx_HelpSystem.README.info
  225.      200     153 23.5% 23-Mar-94 13:24:40  ARexxGuide/Editors/Ed-startup
  226.     2075     717 65.4% 23-Mar-94 13:45:40  ARexxGuide/Editors/Ed-startup.info
  227.      948     343 63.8% 24-Mar-94 16:00:36  ARexxGuide/Extras.info
  228.      940     453 51.8% 23-Mar-94 10:56:06  ARexxGuide/Extras/ARx_Glossary.rexx
  229.     2075     718 65.3% 23-Mar-94 18:23:44  ARexxGuide/Extras/ARx_Glossary.rexx.info
  230.    23455    8023 65.7% 10-Apr-94 14:16:08  ARexxGuide/Extras/ARx_GlossaryPort.rexx
  231.     2075     715 65.5% 24-Mar-94 11:16:10  ARexxGuide/Extras/ARx_GlossaryPort.rexx.info
  232.     3983    1776 55.4% 23-Mar-94 13:29:04  ARexxGuide/Extras/ARx_Help.rexx
  233.     2075     716 65.4% 23-Mar-94 13:30:30  ARexxGuide/Extras/ARx_Help.rexx.info
  234.     5870    2434 58.5% 24-Mar-94 11:39:22  ARexxGuide/Extras/ARx_MakeNodeList.rexx
  235.     2075     715 65.5% 24-Mar-94 11:16:10  ARexxGuide/Extras/ARx_MakeNodeList.rexx.info
  236.     2846    1156 59.3% 24-Mar-94 15:11:18  ARexxGuide/Extras/UnCrunch.rexx
  237.     2075     715 65.5% 24-Mar-94 15:13:14  ARexxGuide/Extras/UnCrunch.rexx.info
  238.    11910    4549 61.8% 10-Apr-94 16:01:34  ARexxGuide/ARexxGuide2_0A.readme
  239.     2075     713 65.6% 24-Mar-94 16:00:52  ARexxGuide/ARexxGuide2_0A.readme.info
  240.    56121   18767 66.5% 10-Apr-94 16:55:12  ARexxGuide/ARx_Tutor.ag
  241. -------- ------- ----- --------- --------
  242.  1117987  347694 68.8% 11-Apr-94 15:55:44   65 files
  243.